/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc.  Portions Copyrighted 2008 Richard Schilling.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s): Richard Schilling (coderroadie@gmail.com)
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.mail.imap.protocol;

import java.util.*;
import com.sun.mail.iap.*;

/**
 * This class and its inner class represent the response to the
 * NAMESPACE command.
 * 
 * @see RFC2342
 * @author Bill Shannon
 */

public class Namespaces {

    /**
     * A single namespace entry.
     */
    public static class Namespace {

        /**
         * Prefix string for the namespace.
         */
        public String prefix;

        /**
         * Delimiter between names in this namespace.
         */
        public char delimiter;

        /**
         * Parse a namespace element out of the response.
         */
        public Namespace(Response r) throws ProtocolException {
            // Namespace_Element = "(" string SP (<"> QUOTED_CHAR <"> / nil)
            // *(Namespace_Response_Extension) ")"
            if (r.readByte() != '(')
                throw new ProtocolException("Missing '(' at start of Namespace");
            // first, the prefix
            prefix = BASE64MailboxDecoder.decode(r.readString());
            r.skipSpaces();
            // delimiter is a quoted character or NIL
            if (r.peekByte() == '"') {
                r.readByte();
                delimiter = (char) r.readByte();
                if (delimiter == '\\')
                    delimiter = (char) r.readByte();
                if (r.readByte() != '"')
                    throw new ProtocolException("Missing '\"' at end of QUOTED_CHAR");
            } else {
                String s = r.readAtom();
                if (s == null)
                    throw new ProtocolException("Expected NIL, got null");
                if (!s.equalsIgnoreCase("NIL"))
                    throw new ProtocolException("Expected NIL, got " + s);
                delimiter = 0;
            }
            // at end of Namespace data?
            if (r.peekByte() != ')') {
                // otherwise, must be a Namespace_Response_Extension
                // Namespace_Response_Extension = SP string SP
                // "(" string *(SP string) ")"
                r.skipSpaces();
                r.readString();
                r.skipSpaces();
                r.readStringList();
            }
            if (r.readByte() != ')')
                throw new ProtocolException("Missing ')' at end of Namespace");
        }
    };

    /**
     * The personal namespaces.
     * May be null.
     */
    public Namespace[] personal;

    /**
     * The namespaces for other users.
     * May be null.
     */
    public Namespace[] otherUsers;

    /**
     * The shared namespace.
     * May be null.
     */
    public Namespace[] shared;

    /**
     * Parse out all the namespaces.
     */
    public Namespaces(Response r) throws ProtocolException {
        personal = getNamespaces(r);
        otherUsers = getNamespaces(r);
        shared = getNamespaces(r);
    }

    /**
     * Parse out one of the three sets of namespaces.
     */
    private Namespace[] getNamespaces(Response r) throws ProtocolException {
        r.skipSpaces();
        // Namespace = nil / "(" 1*( Namespace_Element) ")"
        if (r.peekByte() == '(') {
            Vector v = new Vector();
            r.readByte();
            do {
                Namespace ns = new Namespace(r);
                v.addElement(ns);
            } while (r.peekByte() != ')');
            r.readByte();
            Namespace[] nsa = new Namespace[v.size()];
            v.copyInto(nsa);
            return nsa;
        } else {
            String s = r.readAtom();
            if (s == null)
                throw new ProtocolException("Expected NIL, got null");
            if (!s.equalsIgnoreCase("NIL"))
                throw new ProtocolException("Expected NIL, got " + s);
            return null;
        }
    }
}
